MINOR: Fix incomplete Javadoc comments in storage module #20778
Conversation
- Add missing @return description in ProducerManager.publishMessage() - Add missing @return description in RemoteLogMetadataCache.listAllRemoteLogSegments() - Add missing @throws description in LogDirFailureChannel.takeNextOfflineLogDir() All Javadoc tags now have proper descriptions following Apache Kafka documentation standards.
github-actions
bot
added
triage
|
@atheendre130505 Thanks for the contribution. Could you follow the guide to modify PR title? Thanks. https://cwiki.apache.org/confluence/display/KAFKA/Contributing+Code+Changes |
|
A label of 'needs-attention' was automatically added to this PR in order to raise the |
atheendre130505
changed the title
|
@chia7712 @FrankYang0529 All checks have passed. Ready for merge. Thanks! |
|
A label of 'needs-attention' was automatically added to this PR in order to raise the |
|
@atheendre130505 thanks for this patch! |
This PR addresses incomplete Javadoc comments in the storage module. It adds proper descriptions to all relevant Javadoc tags according to Apache Kafka documentation standards: Adds missing @return description in ProducerManager.publishMessage() Adds missing @return description in RemoteLogMetadataCache.listAllRemoteLogSegments() Adds missing @throws description in LogDirFailureChannel.takeNextOfflineLogDir() No functional code changes are introduced. All updates are strictly to improve code documentation clarity and compliance. Reviewers: Chia-Ping Tsai <[email protected]>
3 participants
This PR addresses incomplete Javadoc comments in the storage module. It
adds proper descriptions to all relevant Javadoc tags according to
Apache Kafka documentation standards:
Adds missing @return description in ProducerManager.publishMessage()
Adds missing @return description in
RemoteLogMetadataCache.listAllRemoteLogSegments()
Adds missing @throws description in
LogDirFailureChannel.takeNextOfflineLogDir()
No functional code changes are introduced. All updates are strictly to
improve code documentation clarity and compliance.
Reviewers: Chia-Ping Tsai [email protected]